Skip to content

Add support for including map/game saves in replays. #6189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 14 commits into
base: master
Choose a base branch
from
Open

Add support for including map/game saves in replays. #6189

wants to merge 14 commits into from

Conversation

@ElectroJr
Copy link
Member

@ElectroJr ElectroJr commented Sep 9, 2025 •
edited
Loading

This PR adds some new methods to make it easier to include map/game saves in replays. Specifically it:

  • Adds IReplayFileWriter.WriteYaml() to make it easier to write yaml documents. This could already be done with WriteBytes, but this is more convenient.
  • Adds MapLoaderSystem.TrySerializeAllEntities(), which will attempt to serialize all entities to a single yaml file.
  • Marks ActorComponent as an "UnsavedComponent"
    • This was never actually supported, and would cause NREs when trying to access ActorComponent.PlayerSession, so I consider this more of a bugfix and not a breaking change.

@ElectroJr ElectroJr mentioned this pull request Sep 9, 2025
Open
2 tasks
@Roudenn
Copy link
Contributor

Roudenn commented Sep 9, 2025 •
edited
Loading

That one's very good, but some parts are heavily conflicted with #6166. Probably would be better to take your version tho, so I encourage you to keep developing this!

Also we probably should somehow cooperate on who does what changes and how

@Roudenn Roudenn mentioned this pull request Sep 9, 2025
Draft
4 tasks
@Roudenn
Copy link
Contributor

Roudenn commented Sep 9, 2025

#6166 I updated my PR to have more info in Technical Details part. I plan to create a file structure in which all systems can save their own files to, so it's a .zip archive with a bunch of files and versions.yml.
Not sure about in which order we should merge these 2 PRs, but probably would be better for this one to be first. Then i will just replace saving of all entities with a full game save and it should work fine.

@ElectroJr
Copy link
Member Author

That one's very good, but some parts are heavily conflicted with #6166.

Ah my bad, I should have had a proper look at the already open PRs before working on this. I've been rather inactive and hadn't noticed that PR had been created. I'll take a look it tomorrow, for now I need sleep.

@deltanedas
Copy link
Contributor

shouldve looked harder at the thousand open prs yeah shame on you :trollface:

@ElectroJr
Copy link
Member Author

shouldve looked harder at the thousand open prs yeah shame on you :trollface:

Alas, not sure I can use that excuse for engine PRs, I was just too focused on implementing my replay idea to bother checking open PRs

@ElectroJr ElectroJr mentioned this pull request Sep 10, 2025
Open
2 tasks
@ElectroJr ElectroJr marked this pull request as ready for review September 23, 2025 04:10
@ElectroJr ElectroJr added the A: Replays Replay playback and recording label Sep 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@PJB3005 PJB3005 Awaiting requested review from PJB3005 PJB3005 is a code owner

@DrSmugleaf DrSmugleaf Awaiting requested review from DrSmugleaf DrSmugleaf is a code owner

Assignees

No one assigned

Labels

A: Replays Replay playback and recording A: Serialization

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ElectroJr @Roudenn @deltanedas